[Misc] Miscellaneous Settings
This section collects basic settings, including the name and location of your backup. The section also indicates whether you are keeping more than a single backup file, as specified by the restorePointLimit
parameter.
Parameter | Default | Configuration Setting and Description |
---|---|---|
snapshotName |
snapshotName |
The base name of the backup. This name is used in the directory tree structure that Each iteration in this series (up to restorePointLimit) consists of the snapshotName and a timestamp for a specific backup. Each series of backups should have a unique and descriptive snapshotName. Full and object-level backups also cannot share names. For most vbr tasks, the snapshotName serves as a useful identifier in diagnostics and system tables. For object restore and replication tasks, snapshotName is used to build schema names in coexist mode operations. A snapshotName can contain up to 240 characters. The snapshot name may contain only the following characters; all others are invalid:
|
tempDir |
/tmp/vbr |
Specifies an absolute path to a temporary storage area on the cluster nodes. The Do not specify the same location as your database's data or catalog directory. Any unexpected files or directories in your data or catalog location can cause errors during database start or restore. The file system at this location must support fcntl lockf (POSIX) file locking. |
restorePointLimit |
1 |
Specifies the number of historical backups to retain in addition to the most recent backup. For example, if you set Saves multiple backups to the same location, which are shared through hard links. In such cases, listbackup displays the common backup prefix but indicates unique time and date suffixes:
|
objects |
|
For an object-level backup or object replication, specifies the object (schema or table) names to include. To specify more than one object, enter multiple names in a comma-separated list. To identify objects using wildcards, use the Specify table names in the form Object names can include UTF-8 alphanumeric characters. Object names cannot include escape characters, single quote ('), or double quote (") characters. Specify non-alphanumeric characters with a backslash (\) followed by a hex value. For instance, if the table name is
This parameter conflicts with the If you do not specify any objects, |
objectRestoreMode |
createOrReplace |
Specifies how Valid Values:
In all modes, |
retryCount |
2 |
(Deprecated) Specifies the number of backup attempts to make. If the backup fails after exceeding the number of retry attempts, |
retryDelay |
1 |
(Deprecated) Specifies the number of seconds to wait between backup retry attempts, if a failure occurs. |
passwordFile |
None |
Specifies the file name of the password configuration file. |
enableFreeSpaceCheck |
True |
When enabled, vbr confirms that the specified backup locations contain sufficient free space and inodes to allow a successful backup. If a backup location has insufficient resources, vbr displays an error message and cancels the backup. If vbr cannot determine the amount of available space or number of inodes in the backupDir, it displays a warning and continues with the backup.If you do not include this setting in your configuration file, vbr performs the space check by default. |
SnapshotEpochLagFailureThreshold |
3600 |
When performing a backup, replication, or copycluster task, specifies the maximum acceptable difference, in seconds, between the current epoch and the backup epoch. If the time between the current epoch and the backup epoch exceeds the value specified in this parameter, vbr displays an error message. A value of 0 disables this check. If you do not include this setting in your configuration file, vbr performs this check using the default value. Backups do not contain information committed after the backup epoch. |
includeObjects |
None |
Identifies database objects and wildcard patterns to include with a backup task. Use a comma to delimit multiple objects and wildcard patterns. For more information, refer to Including and Excluding Objects Using Wildcards. You can use this parameter together with |
excludeObjects |
None |
Identifies database objects and wildcard patterns to exclude from the set specified by |